ARMS用户体验监控提供一系列SDK配置项，让您能够通过设置参数来满足额外需求。本文介绍Android应用常用的SDK配置。
启动配置
启动配置类的接口，需通过链式调用方式随
AlibabaCloudRum.withAppID(appID).withConfigAddress(configAddress).start(getApplicationContext());一同配置。启动配置类的接口需要在调用
start方法之前、withAppID方法之后进行相关配置。在start方法之后配置无效。可同时配置多项。
设置Config地址
每个应用都需要关联对应的Config地址。
AlibabaCloudRum withConfigAddress(String configAddress)参数 | 说明 | 参数限制 | 失败结果 |
configAddress | Config地址 | 字符串长度大于0且小于2083。 | 接口调用失败，SDK停止。 |
设置自定义设备ID
可以通过此方法设置自定义设备ID，设置成功后，SDK将不再使用默认获取的设备ID。
AlibabaCloudRum withDeviceID(String deviceID)参数 | 说明 | 参数限制 | 失败结果 |
deviceID | 自定义的设备ID | 字符串长度大于0且小于256，且不包含特殊字符，仅支持字母、数字、下划线（_）和英文半角连接号（-）。 | 接口调用失败，当次设置无效。 |
设置自定义App版本号
通过此方法设置了自定义App版本号，那么SDK将会上报此版本号，不再使用默认获取的版本号。
AlibabaCloudRum withAppVersion(String appVersion)参数 | 说明 | 参数限制 | 失败结果 |
appVersion | 自定义的App版本号 | 字符串长度大于0且小于64。 | 接口调用失败，当次设置无效。 |
设置用户渠道ID
区分应用发布的渠道。
AlibabaCloudRum withChannelID(String channelID)参数 | 说明 | 参数限制 | 失败结果 |
channelID | 自定义的渠道号 | 字符串长度大于0且小于256。 | 接口调用失败，当次设置无效。 |
设置应用环境
区分应用的环境。通过此方法可以指定应用的环境，如LOCAL、DAILY、PROD等。
AlibabaCloudRum withEnvironment(Env env) 参数 | 说明 | 参数限制 | 失败结果 |
env | 应用环境的枚举值。需要在 | Env枚举：
| 接口调用失败，当次设置无效。 |
自定义信息
自定义用户名称
SDK支持设置与用户相关的信息，从而完成数据分析与实际用户相关联的需求场景。
void setUserName(String userName)参数 | 说明 | 参数限制 | 失败结果 |
userName | 用户名称标识 | 字符串可为null或空串。 字符串小于等于256，且不包含特殊字符，只允许数字、字母、英文半角冒号（:）、空格、正斜线（/）、下划线（_）、英文半角连接号（-）、英文半角句号（.）和@。 | 接口调用失败，当次设置无效。 |
自定义用户扩展信息
SDK支持设置与用户相关的信息，从而完成数据分析与实际用户相关联的需求场景。
void setUserExtraInfo(Map<String, Object> extraInfo)参数 | 说明 | 参数限制 | 失败结果 |
extraInfo | 用户扩展信息 | Map可为空或空集。 转JSON后长度在7000字符以内，否则接口调用失败。 | 接口调用失败，当次设置无效。 |
自定义全局属性
自定义全局属性设置后，新产生的数据会自动携带该业务属性信息，用于分析与业务属性相关联的需求。
void setExtraInfo(Map<String, Object> extraInfo)
void addExtraInfo(Map<String, Object> extraInfo)参数 | 说明 | 参数限制 | 失败结果 |
extraInfo | 属性信息 | Map可为空或空集。转JSON后长度在7000字符以内，否则接口调用失败。 | 接口调用失败，当次设置无效。 |
调用 setExtraInfo 方法时会清空历史设置的属性信息。如您需要追加新的属性信息，建议您通过 addExtraInfo 方法。
自定义异常
调用自定义异常接口，并传入相应的参数，可完成自定义异常数据的统计功能。
void setCustomException(Throwable exception) // 推荐使用，直接将Exception或Throwable对象传入即可参数 | 说明 | 参数限制 | 失败结果 |
exception | 异常对象 | 系统抛出或自行构造的异常对象，非null。 | 接口调用失败，当次设置无效。 |
void setCustomException(String type, String causeBy, String errorDump)参数 | 说明 | 参数限制 | 失败结果 |
type | 异常类型（必要） | 字符串长度大于0且小于等于256。 | 接口调用失败，当次设置无效。 |
causeBy | 异常原因 | 字符串可为null或空串。 字符串小于等于512，超长会截取。 | 不涉及 |
errorDump | 异常信息 | 字符串可为null或空串。 字符串小于等于10000，超长会截取。 | 不涉及 |
自定义事件
SDK支持上报自定义事件。调用相应的接口，并传入相应的参数，可完成自定义事件数据的统计功能。
void setCustomEvent(String eventName)参数 | 说明 | 参数限制 | 失败结果 |
eventName | 事件名称（必要） | 字符串小于等于512，超长会截取。 | 接口调用失败，当次设置无效。 |
void setCustomEvent(String eventName, String group)参数 | 说明 | 参数限制 | 失败结果 |
eventName | 事件名称（必要） | 字符串小于等于512，超长会截取。 | 接口调用失败，当次设置无效。 |
group | 事件分组 | 字符串可为null或空串。 字符串小于等于256，超长会截取。 | 不涉及 |
void setCustomEvent(String eventName, String group, String snapshots)参数 | 说明 | 参数限制 | 失败结果 |
eventName | 事件名称（必要） | 字符串小于等于512，超长会截取。 | 接口调用失败，当次设置无效。 |
group | 事件分组 | 字符串可为null或空串。 字符串小于等于256，超长会截取。 | 不涉及 |
snapshots | 事件快照 | 字符串可为null或空串。 字符串小于等于7000，超长会截取。 | 不涉及 |
void setCustomEvent(String eventName, String group, double value) 参数 | 说明 | 参数限制 | 失败结果 |
eventName | 事件名称（必要） | 字符串小于等于512，超长会截取。 | 接口调用失败，当次设置无效。 |
group | 事件分组 | 字符串可为null或空串。 字符串小于等于256，超长会截取。 | 不涉及 |
value | 事件值 | Double类型 | 不涉及 |
void setCustomEvent(String eventName, String group, Map<String, Object> attributes) 参数 | 说明 | 参数限制 | 失败结果 |
eventName | 事件名称（必要） | 字符串小于等于512，超长会截取。 | 接口调用失败，当次设置无效。 |
group | 事件分组 | 字符串可为null或空串。 字符串小于等于256，超长会截取。 | 不涉及 |
attributes | KV存储信息 | 转JSON后长度在7000字符以内。 | 不涉及 |
void setCustomEvent(String eventName, String group, String snapshots, double value)参数 | 说明 | 参数限制 | 失败结果 |
eventName | 事件名称（必要） | 字符串小于等于512，超长会截取。 | 接口调用失败，当次设置无效。 |
group | 事件分组 | 字符串可为null或空串。 字符串小于等于256，超长会截取。 | 不涉及 |
snapshots | 事件快照 | 字符串可为null或空串。 字符串小于等于7000，超长截取。 | 不涉及 |
value | 事件值 | Double类型 | 不涉及 |
void setCustomEvent(String eventName, String group, String snapshots, Map<String, Object> attributes)参数 | 说明 | 参数限制 | 失败结果 |
eventName | 事件名称（必要） | 字符串小于等于512，超长会截取。 | 接口调用失败，当次设置无效。 |
group | 事件分组 | 字符串可为null或空串。 字符串小于等于256，超长会截取。 | 不涉及 |
snapshots | 事件快照 | 字符串可为null或空串。 字符串小于等于7000，超长截取。 | 不涉及 |
attributes | KV存储信息 | 转JSON后长度在7000字符以内。 | 不涉及 |
void setCustomEvent(String eventName, String group, double value, Map<String, Object> attributes)参数 | 说明 | 参数限制 | 失败结果 |
eventName | 事件名称（必要） | 字符串小于等于512，超长会截取。 | 接口调用失败，当次设置无效 |
group | 事件分组 | 字符串可为null或空串。 字符串小于等于256，超长会截取。 | 不涉及 |
value | 事件值 | Double类型 | 不涉及 |
attributes | KV存储信息 | 转JSON后长度在7000字符以内。 | 不涉及 |
void setCustomEvent(String eventName, String group, String snapshots, double value, Map<String, Object> attributes) 参数 | 说明 | 参数限制 | 失败结果 |
eventName | 事件名称（必要） | 字符串小于等于512，超长会截取。 | 接口调用失败，当次设置无效。 |
group | 事件分组 | 字符串可为null或空串。 字符串小于等于256，超长会截取。 | 不涉及 |
snapshots | 事件快照 | 字符串可为null或空串。 字符串小于等于7000，超长截取。 | 不涉及 |
value | 事件值 | Double类型 | 不涉及 |
attributes | KV存储信息 | 转JSON后长度在7000字符以内。 | 不涉及 |
自定义日志
SDK支持上报自定义日志信息。调用相应的接口，并传入相应的参数，可完成自定义日志数据的统计功能。
void setCustomLog(String content)参数 | 说明 | 参数限制 | 失败结果 |
content | 日志信息（必要） | 字符串长度大于0且小于等于10000，超长会被截取。 | 接口调用失败，当次设置无效。 |
void setCustomLog(String content, String name) 参数 | 说明 | 参数限制 | 失败结果 |
content | 日志信息（必要） | 字符串长度大于0且小于等于10000，超长会被截取。 | 接口调用失败，当次设置无效。 |
name | 日志名称 | 字符串长度大于0且小于等于256。 | 不涉及 |
void setCustomLog(String content, String name, String snapshots)参数 | 说明 | 参数限制 | 失败结果 |
content | 日志信息（必要） | 字符串长度大于0且小于等于10000，超长会被截取。 | 接口调用失败，当次设置无效。 |
name | 日志名称 | 字符串长度大于0且小于等于256。 | 不涉及 |
snapshots | 日志快照 | 字符串可为null或空串。 字符串小于等于7000，超长会截取。 | 不涉及 |
void setCustomLog(String content, String name, String snapshots, String level, Map<String, Object> attributes) 参数 | 说明 | 参数限制 | 失败结果 |
content | 日志信息（必要） | 字符串长度大于0且小于等于10000，超长会被截取。 | 接口调用失败，当次设置无效。 |
name | 日志名称 | 字符串长度大于0且小于等于256。 | 不涉及 |
snapshots | 日志快照 | 字符串可为null或空串。 字符串小于等于7000，超长会截取。 | 不涉及 |
level | 日志等级 | 字符串长度大于0且小于等于256，默认为INFO。 | 不涉及 |
info | 日志附加信息 | Map可为空或空集。 转JSON后，字符串长度与content共享，否则接口调用失败。 | 不涉及 |